[JsonPath] Add documentation #20974
Draft
[JsonPath] Add documentation #20974
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Comment on lines
+86
to
+89
| Tests | ||
| ~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| (show tests examples) |
There was a problem hiding this comment.
Here you can talk about the newly merged PR: #20977
There was a problem hiding this comment.
Awesome PR! Will be very useful, thanks
| Vestibulum id velit turpis. Sed vitae nisl placerat, rutrum ex nec, porta ante. | ||
| Maecenas condimentum cursus risus at fringilla. | ||
|
|
||
| Ready-to-use functions |
There was a problem hiding this comment.
You may first introduce basic queries, then talk about built-in functions in the advanced usages part.
Comment on lines
+9
to
+16
| The Symfony JsonPath component parses JSON strings to retrieve specifics values. | ||
|
|
||
| `JSON`_, *JavaScript Object Notation*, is a lightweight data-interchange format. | ||
| It is easy for humans to read and write. JSON is a widely used format in REST API and data manipulation. | ||
|
|
||
| .. tip:: | ||
|
|
||
| Learn more about `JSONPath`_ specifications. |
There was a problem hiding this comment.
I'm not sure you need to explain what JSON is, but rather explain what Json Path is, that it is defined in RFC9535, etc. It can be short and use the same description as the package itself (see https://packagist.org/packages/symfony/json-path).
There was a problem hiding this comment.
Noted, it was a part I wasn't sure about, I'll update it
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello!
This is the rough sketch of the structure of the documentation I plan to write? I will replace the lorem ipsum of the Why part during the week-end, for the rest, I'm open to suggestions on how to do since it's my first contribution of this size.
Thanks in advance for the time taken and your suggestions.
Will fix #20837